home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / perl5 / Mail / Mailer.pod < prev    next >
Text File  |  2008-04-14  |  4KB  |  145 lines
  1. =head1 NAME
  2.  
  3. Mail::Mailer - Simple interface to electronic mailing mechanisms 
  4.  
  5. =head1 INHERITANCE
  6.  
  7.  Mail::Mailer
  8.    is a IO::Handle
  9.  
  10. =head1 SYNOPSIS
  11.  
  12.   use Mail::Mailer;
  13.   use Mail::Mailer qw(mail);    # specifies default mailer
  14.  
  15.   $mailer = Mail::Mailer->new;
  16.   $mailer = Mail::Mailer->new($type, @args);
  17.  
  18.   $mailer->open(\%headers);
  19.   print $mailer $body;
  20.   $mailer->close;
  21.  
  22. =head1 DESCRIPTION
  23.  
  24. Sends mail using any of the built-in methods.  As TYPE argument
  25. to L<new()|Mail::Mailer/"Constructors">, you can specify any of
  26.  
  27. =over 4
  28.  
  29. =item C<sendmail>
  30.  
  31. Use the C<sendmail> program to deliver the mail.
  32.  
  33. =item C<smtp>
  34.  
  35. Use the C<smtp> protocol via Net::SMTP to deliver the mail. The server
  36. to use can be specified in C<@args> with
  37.  
  38.     $mailer = Mail::Mailer->new('smtp', Server => $server);
  39.  
  40. The smtp mailer does not handle C<Cc> and C<Bcc> lines, neither their
  41. C<Resent-*> fellows. The C<Debug> options enables debugging output
  42. from C<Net::SMTP>.
  43.  
  44. You may also use the C<< Auth => [ $user, $password ] >> option for SASL
  45. authentication (requires L<Authen::SASL> and L<MIME::Base64>).
  46.  
  47. =item C<qmail>
  48.  
  49. Use qmail's qmail-inject program to deliver the mail.
  50.  
  51. =item C<testfile>
  52.  
  53. Used for debugging, this displays the data to the file named in
  54. C<$Mail::Mailer::testfile::config{outfile}> which defaults to a file
  55. named C<mailer.testfile>.  No mail is ever sent.
  56.  
  57. =back
  58.  
  59. C<Mail::Mailer> will search for executables in the above order. The
  60. default mailer will be the first one found.
  61.  
  62. =head1 METHODS
  63.  
  64. =head2 Constructors
  65.  
  66. Mail::Mailer-E<gt>B<new>(TYPE, ARGS)
  67.  
  68. =over 4
  69.  
  70. The TYPE is one of the back-end sender implementations, as described in
  71. the DESCRIPTION chapter of this manual page.  The ARGS are passed to
  72. that back-end.
  73.  
  74. =back
  75.  
  76. $obj-E<gt>B<open>(HASH)
  77.  
  78. =over 4
  79.  
  80. The HASH consists of key and value pairs, the key being the name of
  81. the header field (eg, C<To>), and the value being the corresponding
  82. contents of the header field.  The value can either be a scalar
  83. (eg, C<gnat@frii.com>) or a reference to an array of scalars
  84. (C<< eg, ['gnat@frii.com', 'Tim.Bunce@ig.co.uk'] >>).
  85.  
  86. =back
  87.  
  88. =head1 DETAILS
  89.  
  90. =head2 ENVIRONMENT VARIABLES
  91.  
  92. =over 4
  93.  
  94. =item PERL_MAILERS
  95.  
  96. Augments/override the build in choice for binary used to send out
  97. our mail messages.
  98.  
  99. Format:
  100.  
  101.     "type1:mailbinary1;mailbinary2;...:type2:mailbinaryX;...:..."
  102.  
  103. Example: assume you want you use private sendmail binary instead
  104. of mailx, one could set C<PERL_MAILERS> to:
  105.  
  106.     "mail:/does/not/exists:sendmail:$HOME/test/bin/sendmail"
  107.  
  108. On systems which may include C<:> in file names, use C<|> as separator
  109. between type-groups.
  110.  
  111.     "mail:c:/does/not/exists|sendmail:$HOME/test/bin/sendmail"
  112.  
  113. =back
  114.  
  115. =head2 BUGS
  116.  
  117. Mail::Mailer does not help with folding, and does not protect
  118. against various web-script hacker attacks, for instance where
  119. a new-line is inserted in the content of the field.
  120.  
  121. =head1 SEE ALSO
  122.  
  123. This module is part of the MailTools distribution,
  124. F<http://perl.overmeer.net/mailtools/>.
  125.  
  126. =head1 AUTHORS
  127.  
  128. The MailTools bundle was developed by Graham Barr.  Later, Mark
  129. Overmeer took over maintenance without development.
  130.  
  131. Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
  132. Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
  133. Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
  134. For other contributors see ChangeLog.
  135.  
  136. =head1 LICENSE
  137.  
  138. Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
  139. 2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
  140.  
  141. This program is free software; you can redistribute it and/or modify it
  142. under the same terms as Perl itself.
  143. See F<http://www.perl.com/perl/misc/Artistic.html>
  144.  
  145.